de.cebis.moccabox.io
Class StandardIODefinition

java.lang.Object
  de.cebis.moccabox.io.StandardIODefinition

All Implemented Interfaces:

ITaskCommandCollection, IODefinition, IModelSource, java.io.Serializable

public class StandardIODefinition
extends java.lang.Object
implements IODefinition, java.io.Serializable

Standardimplementierung des Interface IODefinition.

Das IODefinition-Interface spezifiziert den Aufruf eines Anwenders (IClient) über den gesamten Lebenszyklus des IO. Die IODefinition dient als Grundlage für die Interpretation des IO als Präsentation für den Nutzer (z.B. in HTML oder PDF).

Author:

weichelt - 21.01.2005

See Also:

Serialized Form

Field Summary

Fields inherited from interface de.cebis.moccabox.io.IODefinition

SESSION_KEY

Fields inherited from interface de.cebis.moccabox.model.IModelSource

FIELD_MODEL

Constructor Summary

StandardIODefinition()
Parameterloser Konstruktor zum Erzeugen einer neuen StandardIODefinition.

StandardIODefinition(IClient client)
Konstruktor zum Erzeugen einer neuen StandardIODefinition.

Method Summary

void	addMessage(Message message) Hinzufügen einer Meldung, die dem IO mitgegeben werden soll.
IClient	getClient() Zurückliefern des Anwenders (maschinell oder personell), der das IO abgesendet hat.
Message[]	getMessages() Zurückliefern aller Meldungen, die dem IO mitgegeben wurden.
ModelNode	getModel() Zurückliefern des ModelNode, der dem Aufruf zu Grunde liegt.
java.lang.String	getState() Zurückliefern des aktuellen Zustands des Vorgangs der mit dem IO korrespondiert.
TaskCommand	getTaskCommand() Zurückliefern des Kommandos, das das IO ausgelöst hat.
TaskCommandContainer	getTaskCommandContainer() Zurückliefern des Containers, der alle verfügbaren TaskCommand-Objekte beinhaltet.
boolean	hasMessages() Zurückliefern, ob der IODefinition Meldungen mitgegeben wurden.
Message[]	readMessages() Zurückliefern aller Meldungen, die dem IO mitgegeben wurden.
TaskCommand[]	retrieveTaskCommands() Liefert die entsprechenden TaskCommand Objekte zurück, die gehalten werden.
void	setClient(IClient client) Setzen des Anwenders (maschinell oder personell), der das IO abgesendet hat.
void	setMessages(Message[] messages) Setzen einer Menge von Meldungen, die dem IO mitgegeben werden sollen.
void	setModel(ModelNode model) Setzen des ModelNode, der dem Aufruf zu Grunde liegt.
void	setState(java.lang.String state) Setzen des Zustands des korrespondierenden Vorgangs.
void	setTaskCommand(TaskCommand command) Setzen des Kommandos, das das IO ausgelöst hat.
void	setTaskCommandContainer(TaskCommandContainer taskCommandContainer) Setzen des Containers, der alle verfügbaren TaskCommand-Objekte beinhaltet.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StandardIODefinition

public StandardIODefinition(IClient client)

Konstruktor zum Erzeugen einer neuen StandardIODefinition.

Parameters:

client - Der aufrufende Anwender.

StandardIODefinition

public StandardIODefinition()

Parameterloser Konstruktor zum Erzeugen einer neuen StandardIODefinition.

Method Detail

setModel

public void setModel(ModelNode model)

Description copied from interface: IODefinition

Setzen des ModelNode, der dem Aufruf zu Grunde liegt.

Specified by:

setModel in interface IODefinition

Parameters:

model - Die Abstraktion der Anwendung aus Sicht der IO-Schicht.

getModel

public ModelNode getModel()

Description copied from interface: IODefinition

Zurückliefern des ModelNode, der dem Aufruf zu Grunde liegt. Der ModelNode stellt im Sinne des MVC-Modells (Model-View-Controller) das Model dar und wird vom GUI-Framework für die interaktive Ausgabe an den Anwender interpretiert.

Specified by:

getModel in interface IODefinition

Specified by:

getModel in interface IModelSource

Returns:

Die Abstraktion der Anwendung aus Sicht der IO-Schicht.

setClient

public void setClient(IClient client)

Description copied from interface: IODefinition

Setzen des Anwenders (maschinell oder personell), der das IO abgesendet hat.

Specified by:

setClient in interface IODefinition

Parameters:

client - Der beauftragende Client.

getClient

public IClient getClient()

Description copied from interface: IODefinition

Zurückliefern des Anwenders (maschinell oder personell), der das IO abgesendet hat.

Specified by:

getClient in interface IODefinition

Returns:

Der beauftragende Client.

setTaskCommand

public void setTaskCommand(TaskCommand command)

Description copied from interface: IODefinition

Setzen des Kommandos, das das IO ausgelöst hat.

Specified by:

setTaskCommand in interface IODefinition

Parameters:

command - Das abgesetzte Kommando.

getTaskCommand

public TaskCommand getTaskCommand()

Description copied from interface: IODefinition

Zurückliefern des Kommandos, das das IO ausgelöst hat.

Specified by:

getTaskCommand in interface IODefinition

Returns:

Das abgesetzte Kommando.

addMessage

public void addMessage(Message message)

Description copied from interface: IODefinition

Hinzufügen einer Meldung, die dem IO mitgegeben werden soll.

Specified by:

addMessage in interface IODefinition

Parameters:

message - Neue Meldung.

getMessages

public Message[] getMessages()

Description copied from interface: IODefinition

Zurückliefern aller Meldungen, die dem IO mitgegeben wurden.

Specified by:

getMessages in interface IODefinition

Returns:

Alle Meldungen des IO.

hasMessages

public boolean hasMessages()

Zurückliefern, ob der IODefinition Meldungen mitgegeben wurden.

Returns:

True, falls Meldungen vorhanden sind. False, andernfalls.

readMessages

public Message[] readMessages()

Description copied from interface: IODefinition

Zurückliefern aller Meldungen, die dem IO mitgegeben wurden. Die Meldungen werden dabei auch gelöscht, so dass sie nach dem Auslesen nicht nochmals angezeigt werden können.

Specified by:

readMessages in interface IODefinition

Returns:

Alle Meldungen des IO.

setMessages

public void setMessages(Message[] messages)

Setzen einer Menge von Meldungen, die dem IO mitgegeben werden sollen.

Parameters:

messages - Mitzugebende Meldungen.

retrieveTaskCommands

public TaskCommand[] retrieveTaskCommands()

Description copied from interface: ITaskCommandCollection

Liefert die entsprechenden TaskCommand Objekte zurück, die gehalten werden.

Specified by:

retrieveTaskCommands in interface ITaskCommandCollection

Returns:

Array der TaskCommand.

getState

public java.lang.String getState()

Description copied from interface: IODefinition

Zurückliefern des aktuellen Zustands des Vorgangs der mit dem IO korrespondiert. Je nachdem, welchen State der Vorgang eingenommen hat, gilt er als unterbrochen, erfolgreich beendet oder mit Fehler abgebrochen.

Specified by:

getState in interface IODefinition

Returns:

Zustand des Vorgangs.
STATE_INSTANTIATED
STATE_INPUT
STATE_FINISHED_WITH_ERRORS
STATE_FINISHED_WITH_SUCCESS
STATE_FINISHED_INCOMPLETE
STATE_FAILED
STATE_WAITING_FOR_CONFIRMATION

setState

public void setState(java.lang.String state)

Description copied from interface: IODefinition

Setzen des Zustands des korrespondierenden Vorgangs.

Specified by:

setState in interface IODefinition

Parameters:

state - Zustand des Vorgangs.

getTaskCommandContainer

public TaskCommandContainer getTaskCommandContainer()

Description copied from interface: IODefinition

Zurückliefern des Containers, der alle verfügbaren TaskCommand-Objekte beinhaltet. Die Kommandos sind im Behälter zusammengefasst, da sie encoded werden, bevor sie dargestellt werden können. Vor allem für die Verwendung mit dem HTT-Protokoll ist es wichtig, dass in einem GET die Kommandos nicht in Klartext dargestellt werden, da das zu Manipulationen führen kann. Jedes Kommando wird daher durch ein entsprechendes Ticket repräsentiert, das auch nur eine bestimmte Gültigkeitsdauer hat. Sobald es aufgerufen wurde, wird es invalidiert und kann nicht per copy & paste wiederverwendet werden.

Specified by:

getTaskCommandContainer in interface IODefinition

Returns:

Behälter aller verfügbarer TaskCommand-Objekte.

setTaskCommandContainer

public void setTaskCommandContainer(TaskCommandContainer taskCommandContainer)

Description copied from interface: IODefinition

Setzen des Containers, der alle verfügbaren TaskCommand-Objekte beinhaltet.

Specified by:

setTaskCommandContainer in interface IODefinition

Parameters:

taskCommandContainer - Behälter aller verfügbarer TaskCommand-Objekte.